Repository navigation
docs: document releases, publishing and updating feed apps - #51
Merged
Merged
Conversation
- Releasing explains that one vYY.M.PATCH tag on main releases the main app and every feed app with a production id, and uses the same version format as the other Edge App repos. - New sections cover publishing a new feed app (icon, deployed-apps.yml entry, initialize on stage then production, record the ids) and updating one (deployed-apps.yml, code or screenly.yml, one-off runs, removing an app from deploys). - DEPLOYMENT.md keeps how the feed-app workflows work and the field reference, and links to the README for the steps.
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The supplied review evidence identifies no unresolved concerns in the changes.
No open issues 🎉
What changed in this PR
This pull request documents release procedures and the lifecycle of publishing and updating RSS feed apps, while keeping DEPLOYMENT.md focused on workflow and configuration references.
Changes:
- Documents stage and production releases using
vYY.M.PATCHtags. - Adds instructions for publishing, updating, testing, and removing feed apps.
- Links deployment configuration guidance to the README.
| File | Summary |
|---|---|
README.md |
Adds release and feed-app lifecycle documentation. Clarify that adding a feed-app entry and merging to main still triggers normal stage deployments, while an app without an ID is skipped and may cause the feed-app workflow to report “No apps to deploy.” |
DEPLOYMENT.md |
Retains workflow and configuration context while linking to the README for operational procedures. |
deployed-apps.yml |
Updates the configuration comment to direct contributors to the README. |
This pull request requires changes.
Review effort: Lite
salmanfarisvp
added a commit
that referenced
this pull request
Nov 5, 2026
docs: document releases, publishing and updating feed apps
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents how this repo releases, and how to publish and update RSS-based feed apps, in the README.
Releasing
Tag-based releases already work here the same way as in the other Edge App repos.
update-edge-app.ymlis identical to air-quality-app's (sharedupdate.yml@v26.10.2,v[0-9]*tags), and the feed-app workflow responds to the same tags. The README now says so:maindeploys the main app and every feed app to stage.vYY.M.PATCHtag onmaindeploys all of them to production.The version format now matches the other repos (
vYY.M.PATCH, previouslyvYY.MM.Nhere).Publishing a new feed app
The steps: host an icon, add a
deployed-apps.ymlentry with empty ids, initialize on stage, record the id, check it, then do the same for production. The example entry leaves outcategories, because the workflow doesn't apply it (feed apps are still listed as Utilities).Updating a feed app
Covers which change goes where:
deployed-apps.yml.screenly.yml. Every feed app picks it up.It also notes that changing
app_nameafter creation doesn't rename the app.DEPLOYMENT.md
Keeps how the feed-app workflows work and the
deployed-apps.ymlfield reference, and links to the README for the steps, so the two can't drift apart.